home *** CD-ROM | disk | FTP | other *** search
/ Macworld Expo - Develope…Central & Net Innovations / Developer Central and Net Innovators (MacWorld Expo) (January 1999).iso / Developer Central / Metrowerks CodeWarrior / CodeWarrior Pro 4 Release Notes / Java Notes / JavaDoc Linker.txt < prev    next >
Encoding:
Text File  |  1998-09-04  |  5.6 KB  |  132 lines  |  [TEXT/CWIE]
  1. ========================================================================
  2. Metrowerks JavaDoc Pre Linker for Mac OS and Windows NT/95 Release Notes 
  3. ========================================================================
  4.  
  5. Version: 1.3
  6. Date:    Aug. 31, 1998
  7. Author:  Pedro Larios, John Cortell
  8. ========================================================================
  9.  
  10. The file "ln_javadoc.dll" is the Metrowerks JavaDoc Compiler for Windows 
  11. NT/95. On Mac OS it is "JavaDoc Pre Linker".
  12.  
  13. THIS PRE-LINKER REQUIRES THAT YOU HAVE THE LATEST METROWERKS JAVA
  14. compiler (version 1.3.x) since it relies on a new object code format.
  15.  
  16. ON WINDOWS, THIS LINKER REQUIRES THAT YOU HAVE EITHER THE SUN JDK 
  17. or JRE 1.1.6 (or higher) installed. On Mac, this linker now requires 
  18. MRJ 2.0 or later. The installation programs for these are in the "Extras" 
  19. folder at the base of the CodeWarrior Tools CD. The CodeWarrior 
  20. installation program should have installed this for you.
  21.  
  22. ========================================================================
  23. New Features in This Version
  24. ========================================================================
  25. * [MAC ONLY] Plugin uses MRJ VM
  26.    - The JavaDoc plugin now uses the MRJ VM. Therefore, MRJ 2.0 or later
  27.      MUST be installed in the system in order for this plugin to work.
  28.  
  29. * JavaDoc is now a pre-linker.
  30.    - The JavaDoc tool for CodeWarrior is repackaged as a pre linker.
  31.      This will greatly improve performance, eliminating the need to 
  32.      reparse all of the source files in the project when generating the 
  33.      docs. It also allows the docs to be generating in the same build 
  34.      during the regular Java link phase.
  35.  
  36. * Output as folder hierarchy
  37.    - Instead of only outputting the html files for a project to a flat 
  38.      folder hierarchy with extremely long filenames, the tool now will 
  39.      give the option of putting the files into a package-based folder 
  40.      hierarchy. The actual file names will be only the class name.
  41.  
  42. * Create Mac friendly names on Windows
  43.    - The capability to generate filenames shortened to 31 characters can 
  44.      now be set on Windows to allow the user to create cross-platform 
  45.      friendly html docs.
  46.  
  47. * [MAC ONLY]Creator code for HTML
  48.    - The creator code for html files created on the Mac can now be set 
  49.      by the user, rather than being hard coded to Internet Explorer.
  50.  
  51.  
  52. ========================================================================
  53. Bugs Fixed in This Version
  54. ========================================================================
  55. * 1.3b4
  56.    - Javadoc no longer generates inner class docs with spaces in the 
  57.      name.
  58.    - [Windows only] Fixes a problem looking for JDK 1.1.6.
  59.    - Fixed a problem with access modifiers so it correctly generates
  60.      documentation based on the access modifiers specified in the prefs.
  61. * 1.3b1
  62.    - Updating javadoc to the newest compiler object code fixed the problem
  63.      where javadoc would not include argument names when documenting
  64.      methods.
  65. * 1.2b2
  66.    - The linker now supports jar files.
  67. * 1.2b1
  68.    - The linker now supports multiple files of the same name within a 
  69.      given target.
  70. * 1.1.3.B5
  71.    - [Windows only] Would not work with any version of the Sun JDK/JRE
  72.      except for 1.1.3.
  73. * 1.1.3.B4
  74.    - Link would fail if first file in link order was not a .java 
  75.      or .class file.
  76. * 1.1.3.B3
  77.    - Linker would crash because it could not find the JRE or JDK
  78. * 1.1.3.B2
  79.    - JavaDoc now outputs to a unique folder per target. The name of the
  80.      output folder is "Docs - <target_name>".
  81.    - Mac only: The creator code of the output HTML files are now set
  82.      to 'MSIE' and the file type to 'TEXT'.
  83. * 1.1.3.B1
  84.    - When selecting MW JavaDoc as the target linker, java source
  85.      files were being mapped to the "Java" compiler rather than
  86.      the "MW JavaDoc" compiler.
  87.    - Link to the Sun documentation was missing 
  88.  
  89. ========================================================================
  90. Known Bugs and Incompatibilities
  91. ========================================================================
  92.  
  93. * Due to problems in MRJ 2.0 on 68k, this release of JavaDoc is PPC only.
  94.   We are looking into this problem to try and resolve it as soon as 
  95.   possible.
  96.  
  97. ========================================================================
  98. Additional Notes
  99. ========================================================================
  100. The majority of the JavaDoc linker is implemented in Java. To run, it
  101. requires that you have the Sun JDK or JRE installed, version 1.1.6 or
  102. higher.
  103.  
  104. In order to JavaDoc a java project, simply set "JavaDoc Pre Linker" as 
  105. the pre-linker in your project Target settings. You must have the latest
  106. version of the compiler since it relies on a new object code format.
  107. Because of this, old projects will have to be re-compiled in order for
  108. the pre-linker to work.
  109.  
  110. As mentioned above, this linker runs interpreted. Therefore, an 
  111. appropriate Java virtual machine MUST be installed in the system. On 
  112. Windows, the plugin looks for JDK 1.1.6 or later. On the Mac it looks
  113. for MRJ 2.0 or later.
  114.  
  115. ========================================================================
  116. Contacting Metrowerks
  117. ========================================================================
  118.  
  119. For bug reports, technical questions, and suggestions, please use the
  120. forms in the Release Notes folder on the CD, and send them to
  121.  
  122. support@metrowerks.com
  123.  
  124. See the CodeWarrior on the Nets document in the Release Notes folder for
  125. more contact information, including a list of Internet newsgroups, 
  126. online services, and patch and update sites.
  127.  
  128. ========================================================================
  129.  
  130. CodeWarrior Java Engineers
  131. Metrowerks Corporation
  132.